package org.shs.collector.model;

/**
 * Model to encapsulate the details of a particular collector.
 * <br/>
 * <br/><b>Created:</b>&nbsp;&nbsp; Dec 16, 2008 1:09:59 AM
 *
 * @author Gunjan
 */
public class CollectorModel
{

   // The collector id.
   private String collectorId;
   
   // The collector name.
   private String collectorName;
   
   // First line of the collector address.
   private String address1;
   
   // Second line of the collector address.
   private String address2;
   
   // Third line of the collector address.
   private String address3;
   
   // City of the collector.
   private String city;
   
   // State of the collector.
   private String state;
   
   // Postal code of the collector.
   private String postalCode;
   
   // Fixed-line phone number of the collector.
   private String collectorPhone;
   
   // Name of the contact person.
   private String contactName;
   
   // Fixed-line phone number of the contact person.
   private String contactPhone;
   
   // Mobile phone number of the contact person.
   private String contactMobile;
   
   // E-mail address of the contact person.
   private String contactEMail;
   
   // Comments regarding the collector.
   private String comments;

   // Flag specifying if the collector account is active.
   private String active;
   
   // The success/failure message
   private String message = null;

   /**
    * Returns the collector id.
    * @return The collector id.
    */
   public String getCollectorId()
   {
      return collectorId;
   }

   /**
    * Sets the collector id.
    * @param collectorId The collector id.
    */
   public void setCollectorId(String collectorId)
   {
      this.collectorId = collectorId;
   }

   /**
    * Returns the collector name.
    * @return The collector name.
    */
   public String getCollectorName()
   {
      return collectorName;
   }

   /**
    * Sets the collector name. 
    * @param collectorName The collector name.
    */
   public void setCollectorName(String collectorName)
   {
      this.collectorName = collectorName;
   }

   /**
    * Returns first line of the collector address.
    * @return First line of the collector address.
    */
   public String getAddress1()
   {
      return address1;
   }

   /**
    * Sets first line of the collector address.
    * @param address1 First line of the collector address.
    */
   public void setAddress1(String address1)
   {
      this.address1 = address1;
   }

   /**
    * Returns second line of the collector address.
    * @return Second line of the collector address.
    */
   public String getAddress2()
   {
      return address2;
   }

   /**
    * Sets Second line of the collector address.
    * @param address2 Second line of the collector address.
    */
   public void setAddress2(String address2)
   {
      this.address2 = address2;
   }

   /**
    * Returns third line of the collector address.
    * @return Third line of the collector address.
    */
   public String getAddress3()
   {
      return address3;
   }

   /**
    * Sets third line of the collector address.
    * @param address3 Third line of the collector address.
    */
   public void setAddress3(String address3)
   {
      this.address3 = address3;
   }

   /**
    * Returns the city of the collector.
    * @return City of the collector.
    */
   public String getCity()
   {
      return city;
   }

   /**
    * Sets the city of the collector.
    * @param city City of the collector.
    */
   public void setCity(String city)
   {
      this.city = city;
   }

   /**
    * Returns the state of the collector.
    * @return State of the collector.
    */
   public String getState()
   {
      return state;
   }

   /**
    * Sets the sstate of the collector.
    * @param state State of the collector.
    */
   public void setState(String state)
   {
      this.state = state;
   }

   /**
    * Returns the postal code of the collector.
    * @return Postal code of the collector.
    */
   public String getPostalCode()
   {
      return postalCode;
   }

   /**
    * Sets the postal code of the collector.
    * @param postalCode Postal code of the collector.
    */
   public void setPostalCode(String postalCode)
   {
      this.postalCode = postalCode;
   }

   /**
    * Returns the fixed-line phone number of the collector.
    * @return Fixed-line phone number of the collector.
    */
   public String getCollectorPhone()
   {
      return collectorPhone;
   }

   /**
    * Sets the fixed-line phone number of the collector.
    * @param collectorPhone Fixed-line phone number of the collector.
    */
   public void setCollectorPhone(String collectorPhone)
   {
      this.collectorPhone = collectorPhone;
   }

   /**
    * Returns the name of the contact person.
    * @return Name of the contact person.
    */
   public String getContactName()
   {
      return contactName;
   }

   /**
    * Sets the name of the contact person.
    * @param contactName Name of the contact person.
    */
   public void setContactName(String contactName)
   {
      this.contactName = contactName;
   }

   /**
    * Returns the fixed-line phone number of the contact person.
    * @return Fixed-line phone number of the contact person.
    */
   public String getContactPhone()
   {
      return contactPhone;
   }

   /**
    * Sets the fixed-line phone number of the contact person.
    * @param contactPhone Fixed-line phone number of the contact person.
    */
   public void setContactPhone(String contactPhone)
   {
      this.contactPhone = contactPhone;
   }

   /**
    * Returns the mobile phone number of the contact person.
    * @return Mobile phone number of the contact person.
    */
   public String getContactMobile()
   {
      return contactMobile;
   }

   /**
    * Sets the mobile phone number of the contact person.
    * @param contactMobile Mobile phone number of the contact person.
    */
   public void setContactMobile(String contactMobile)
   {
      this.contactMobile = contactMobile;
   }

   /**
    * Returns the e-mail address of the contact person.
    * @return E-mail address of the contact person.
    */
   public String getContactEMail()
   {
      return contactEMail;
   }

   /**
    * Sets the e-mail address of the contact person.
    * @param contactEMail E-mail address of the contact person.
    */
   public void setContactEMail(String contactEMail)
   {
      this.contactEMail = contactEMail;
   }

   /**
    * Returns the comments regarding the collector.
    * @return ments regarding the collector.
    */
   public String getComments()
   {
      return comments;
   }

   /**
    * Sets the comments regarding the collector.
    * @param comments Comments regarding the collector.
    */
   public void setComments(String comments)
   {
      this.comments = comments;
   }

   /**
    * Returns the flag specifying if the collector accounts are active.
    * @return Flag specifying if the collector accounts are active.
    */
   public String getActive()
   {
      return active;
   }

   /**
    * Sets the flag specifying if the collector accounts are active.
    * @param active Flag specifying if the collector accounts are active.
    */
   public void setActive(String active)
   {
      this.active = active;
   }
   
   /**
    * Returns the success/failure message
    * @return the success/failure message
    */
   public String getMessage()
   {
      return message;
   }

   /**
    * Sets the success/failure message
    * @param the success/failure message
    */
   public void setMessage(String message)
   {
      this.message = message;
   }
}